Saltar al contenido principal

Obtener información de las bases de datos

La API de Datum te permite interactuar con bases de datos en Jelou, realizar consultas, y gestionar los datos de manera sencilla.

GET https://api.jelou.ai/v2/databases

Parámetros de consulta

PropiedadTipo de datoDescripción
shouldPaginateStringPaginación de los resultados

Respuestas:

  • 200: OK - Respuesta exitosa.
  • 401: Unauthorized - No autorizado.
  • 500: Internal Server Error - Error en el servidor.

Ejemplo de respuesta:

{
"message": ["¡Bases de datos recuperadas exitosamente!"],
"statusMessage": "success",
"status": 1,
"data": [
{
"id": 123456789,
"name": "JELOU TEST",
"slug": "jeloutest",
"driver": "elastic",
"description": "JELOU TEST",
"companyId": 135,
"schema": {
"type": "object",
"properties": {
"total": { "type": "string", "database": "text" },
"name": { "type": "string", "database": "text" }
},
"required": ["total", "name"]
}
}
]
}

Estructura de la base de datos

PropiedadTipoDescripción
idStringID de la base de datos.
nameStringNombre de la base de datos.
descriptionStringDescripción de la base de datos.
schemaObjectEsquema de la base de datos. Para más información, consulta la estructura del esquema.
stateBooleanEstado de la base de datos. True = Activa, False = Eliminada.
createdAtDateFecha de creación de la base de datos.
updatedAtDateFecha de actualización de la base de datos.
columnsArrayColumnas de la base de datos. Información sobre el nombre, descripción y orden a presentar en Datum.
metadataArrayMetadatos de la base de datos. Metadatos a presentar en Datum.

Estructura del esquema

PropiedadTipo de datoDescripción
typeStringTipo de dato de esquema
requiredArrayArray de Strings. Define los campos obligatorios para insertar un registro.
propertiesObjetoCada elemento es un campo en la base de datos. Dentro de cada campo, el 'type' define el Tipo de dato de dato del elemento.

Obtener información de una base de datos específica

GET https://api.jelou.ai/v2/databases/DATABASE_ID

Parámetros de ruta

PropiedadTipo de datoDescripción
DATABASE_IDStringID de la base de datos

Respuestas:

  • 200: OK - Respuesta exitosa.
  • 401: Unauthorized - No autorizado.
  • 500: Internal Server Error - Error en el servidor.
  • 404: Not Found - No encontrado.

Ejemplo de respuesta:

{
"message": ["¡Base de datos recuperada exitosamente!"],
"statusMessage": "success",
"status": 1,
"data": {
"id": 123456789,
"name": "JELOU TEST",
"slug": "jeloutest",
"schema": {
"type": "object",
"properties": {
"total": { "type": "string", "database": "text" },
"name": { "type": "string", "database": "text" }
},
"required": ["total", "name"]
}
}
}